tmf-prepay-balance-management-biz

URL

https://[localhost]:[port]/tmf-api/prepayBalanceManagement/v4/{businessId}/adjustBalance

URL PARAMS

Header

Request Body for PA

{
    "adjustType": "credit",
    "reason": "SK2.0",
    "amount": {
        "amount": 2,
        "units": "USD"
    },
    "logicalResource": [
        {
            "id": "65554122"
        }
    ],
    "characteristic": [
        {
            "name": "AdjustmentCode",
            "value": "CP"
        },
        {
            "name": "TotalAmount",
            "value": "3"
        },
        {
            "name": "AmountPaid",
            "value": "0.2"
        },
        {
            "name": "transactionId",
            "value": "344849"
        }
    ],
    "@type": "Adelanta Saldo"
}

Definitions

Skipped properties: id,href,status,requestedDate,confirmationDate,relatedParty,partyAccount

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 201 ] for PA

{
    "logicalResource": {
        "id": "65554122",
        "@type": "MSISDN",
        "@baseType": "logicalResource"
    },
    "amount": {
        "units": "USD",
        "amount": 2.0
    }
}

Definitions

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "OCS:ERROR_CODE",
      "description" : "Error description."
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
    "errors" : [{
        "code": 404
        "message": "SUBSCRIBER_NOT_FOUND"
        "description": "Subscriber not found"
    }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
    errors: [{
        code: 500,
        description: "OCS:ERROR",
        message: "Other Error"
    }]
 }

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation POST /adjustBalance for Business Id: xxxx not implemented"
    }]
  }